//-----------------------------------------------------------------------
// <copyright file="EventBrokerException.cs" company="iron9light">
//      Copyright (c) iron9light. All rights reserved.
// </copyright>
// <author>iron9light</author>
//-----------------------------------------------------------------------

namespace EventBroker
{
    using System;
    using System.Runtime.Serialization;

    /// <summary>
    /// An exception thrown by the Event Broker components.
    /// </summary>
    [Serializable]
    public class EventBrokerException : Exception
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="EventBrokerException"/> class.
        /// </summary>
        public EventBrokerException()
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="EventBrokerException"/> class with a specified error message.
        /// </summary>
        /// <param name="message">The message that describes the error.</param>
        public EventBrokerException(string message) 
                : base(message)
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="EventBrokerException"/> class with a specified error message 
        /// and a reference to the inner exception that is the cause of this exception.
        /// </summary>
        /// <param name="message">The error message that explains the reason for the exception.</param>
        /// <param name="innerException">The exception that is the cause of the current exception,
        /// or a null reference if no inner exception is specified.</param>
        public EventBrokerException(string message, Exception innerException)
                : base(message, innerException)
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="EventBrokerException"/> class with serialized data.
        /// </summary>
        /// <param name="info">The <see cref="SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
        /// <param name="context">The <see cref="StreamingContext"/> that contains contextual information about the source or destination.</param>
        /// <exception cref="T:System.ArgumentNullException">
        /// The <paramref name="info"/> parameter is null.
        /// </exception>
        /// <exception cref="T:System.Runtime.Serialization.SerializationException">
        /// The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0).
        /// </exception>
        protected EventBrokerException(SerializationInfo info, StreamingContext context) 
                : base(info, context)
        {
        }
    }
}